home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / u_man / cat3 / Tm / tmcstext.z / tmcstext
Encoding:
Text File  |  1998-10-30  |  11.1 KB  |  331 lines
  1.  
  2.  
  3.  
  4. TTTTmmmmTTTTCCCCSSSSeeeexxxxtttt((((3333TTTTmmmm))))                                                    TTTTmmmmTTTTCCCCSSSSeeeexxxxtttt((((3333TTTTmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      TTTTmmmmCCCCSSSSTTTTeeeexxxxtttt - the CSText widget class
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      xxxxmmmmCCCCSSSSTTTTeeeexxxxtttt  pathName [options]
  13.  
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      This is the _t_c_l binding to the Motif Compound String Text (CSText)
  17.      widget.  This widget is only available from Motif 2.0 on.
  18.  
  19.  
  20. CCCCLLLLAAAASSSSSSSSEEEESSSS
  21.      The class name for resource files is XXXXmmmmCCCCSSSSTTTTeeeexxxxtttt.... Resources are inherited
  22.      from TTTTmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee,,,, TTTTmmmmCCCCoooorrrreeee.... Methods are inherited from TTTTmmmmCCCCoooorrrreeee....
  23.  
  24.      THE REST OF THIS REFERS TO TEXT - UPDATE
  25.  
  26.  
  27. RRRREEEESSSSOOOOUUUURRRRCCCCEEEESSSS
  28.      The new resources are
  29.  
  30.           autoShowCursorPosition
  31.           cursorPosition
  32.           editable
  33.           editMode br marginHeight
  34.           marginWidth
  35.           maxLength
  36.           source
  37.           topCharacter
  38.           value
  39.           valueWCS
  40.           verifyBell
  41.  
  42.      eeeeddddiiiittttaaaabbbblllleeee
  43.           The values for this resource are
  44.                true
  45.                false
  46.      eeeeddddiiiittttMMMMooooddddeeee The values for this resource are
  47.                single_line_edit
  48.                multi_line_edit
  49.  
  50.  
  51. MMMMEEEETTTTHHHHOOOODDDDSSSS
  52.      New methods for this class are
  53.           activateCallback
  54.           focusCallback
  55.           gainPrimaryCallback
  56.           losePrimaryCallback
  57.           losingFocusCallback
  58.           modifyVerifyCallback
  59.           motionVerifyCallback
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. TTTTmmmmTTTTCCCCSSSSeeeexxxxtttt((((3333TTTTmmmm))))                                                    TTTTmmmmTTTTCCCCSSSSeeeexxxxtttt((((3333TTTTmmmm))))
  71.  
  72.  
  73.  
  74.           valueChangedCallback
  75.           clearSelection
  76.           copy
  77.           cut
  78.           disableRedisplay
  79.           enableRedisplay
  80.           findString
  81.           getEditable
  82.           getInsertionPosition
  83.           getSelection
  84.           getSelectionPosition
  85.           getString
  86.           getSubstring
  87.           getTopCharacter
  88.           insert
  89.           paste
  90.           replace
  91.           remove
  92.           scroll
  93.           setAddMode
  94.           setEditable
  95.           setHighlight
  96.           setInsertionPosition
  97.           setSelection
  98.           setSource
  99.           setString
  100.           setTopCharacter
  101.           showPosition
  102.  
  103.  
  104.      cccclllleeeeaaaarrrrSSSSeeeelllleeeeccccttttiiiioooonnnn
  105.           clears the primary selection
  106.  
  107.  
  108.      ccccooooppppyyyy copies the primary selection to the clipboard
  109.  
  110.  
  111.      ccccuuuutttt  copies the primary selection to the clipboard and deletes the
  112.           selected text.
  113.  
  114.  
  115.      ffffiiiinnnnddddSSSSttttrrrriiiinnnngggg  _s_t_a_r_t _s_t_r_i_n_g _d_i_r_e_c_t_i_o_n _p_o_s_i_t_i_o_n
  116.           searches for the _s_t_r_i_n_g in the specified _d_i_r_e_c_t_i_o_n starting from the
  117.           given _s_t_a_r_t. The possible values of _d_i_r_e_c_t_i_o_n are  ffffoooorrrrwwwwaaaarrrrdddd or
  118.           bbbbaaaacccckkkkwwwwaaaarrrrdddd.  The method returns  ttttrrrruuuueeee  or  ffffaaaallllsssseeee  if the string is
  119.           found or not found. If it is found, the location of the first
  120.           character of the string (counting from 0) is returned in the tcl
  121.           variable _p_o_s_i_t_i_o_n.
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. TTTTmmmmTTTTCCCCSSSSeeeexxxxtttt((((3333TTTTmmmm))))                                                    TTTTmmmmTTTTCCCCSSSSeeeexxxxtttt((((3333TTTTmmmm))))
  137.  
  138.  
  139.  
  140.      ggggeeeettttEEEEddddiiiittttaaaabbbblllleeee
  141.           returns  ttttrrrruuuueeee or  ffffaaaallllsssseeee indicating whether or not the widget can be
  142.           edited.
  143.  
  144.  
  145.      ggggeeeettttIIIInnnnsssseeeerrrrttttiiiioooonnnnPPPPoooossssiiiittttiiiioooonnnn
  146.           returns the location of the insertion cursor.
  147.  
  148.  
  149.      ggggeeeettttLLLLaaaassssttttPPPPoooossssiiiittttiiiioooonnnn
  150.           returns the last position in the text.
  151.  
  152.  
  153.      ggggeeeettttSSSSeeeelllleeeeccccttttiiiioooonnnn
  154.           returns the value of the primary selection.
  155.  
  156.  
  157.      ggggeeeettttSSSSeeeelllleeeeccccttttiiiioooonnnnPPPPoooossssiiiittttiiiioooonnnn  _l_e_f_t _r_i_g_h_t
  158.           returns  ttttrrrruuuueeee f the widget owns the primary selection, else returns
  159.           ffffaaaallllsssseeee.  The left and right positions of the primary selection are
  160.           returned in the tcl variables
  161.            _l_e_f_t  and  _r_i_g_h_t.
  162.  
  163.  
  164.      ggggeeeettttSSSSttttrrrriiiinnnngggg
  165.           returns the value in the widget.
  166.  
  167.  
  168.      ggggeeeettttSSSSuuuubbbbssssttttrrrriiiinnnngggg  _s_t_a_r_t _n_u_m__c_h_a_r_s _b_u_f_f_e_r
  169.           stores the substring in the tcl variable _b_u_f_f_e_r. The method returns
  170.           ssssuuuucccccccceeeeddddeeeedddd,  ffffaaaaiiiilllleeeedddd or  ttttrrrruuuunnnnccccaaaatttteeeedddd.
  171.  
  172.  
  173.      ggggeeeettttTTTTooooppppCCCChhhhaaaarrrraaaacccctttteeeerrrr
  174.           returns the position of the first character displayed.
  175.  
  176.  
  177.      iiiinnnnsssseeeerrrrtttt  _p_o_s_i_t_i_o_n _t_e_x_t
  178.           inserts the  _t_e_x_t into the widget at  _p_o_s_i_t_i_o_n.
  179.  
  180.  
  181.      ppppaaaasssstttteeee
  182.           insert the clipboard selection.
  183.  
  184.  
  185.      rrrreeeeppppllllaaaacccceeee  _f_r_o_m _t_o _v_a_l_u_e
  186.           replaces the text with the new  _v_a_l_u_e.
  187.  
  188.  
  189.      ssssccccrrrroooollllllll  _l_i_n_e_s
  190.           scroll the text widget. A negative number of lines scrolls downward.
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. TTTTmmmmTTTTCCCCSSSSeeeexxxxtttt((((3333TTTTmmmm))))                                                    TTTTmmmmTTTTCCCCSSSSeeeexxxxtttt((((3333TTTTmmmm))))
  203.  
  204.  
  205.  
  206.      sssseeeettttAAAAddddddddMMMMooooddddeeee  _b_o_o_l_e_a_n
  207.           sets the add mode of the text widget.
  208.  
  209.  
  210.      sssseeeettttEEEEddddiiiittttaaaabbbblllleeee  _b_o_o_l_e_a_n
  211.           set the editable state of the widget.
  212.  
  213.  
  214.      sssseeeettttHHHHiiiigggghhhhlllliiiigggghhhhtttt   _l_e_f_t _r_i_g_h_t _m_o_d_e
  215.           set the highlight mode for the text between the positions to one of
  216.           the  _h_i_g_h_l_i_g_h_t values of
  217.            nnnnoooorrrrmmmmaaaallll sssseeeelllleeeecccctttteeeedddd sssseeeeccccoooonnnnddddaaaarrrryyyy____sssseeeelllleeeecccctttteeeedddd.
  218.  
  219.  
  220.      sssseeeettttIIIInnnnsssseeeerrrrttttiiiioooonnnnPPPPoooossssiiiittttiiiioooonnnn  _p_o_s_i_t_i_o_n
  221.           set the location of the insertion cursor.
  222.  
  223.  
  224.      sssseeeettttSSSSeeeelllleeeeccccttttiiiioooonnnn  _f_i_r_s_t _l_a_s_t
  225.           set the primary selection of the text to between the positions.
  226.  
  227.  
  228.      sssseeeettttSSSSoooouuuurrrrcccceeee  _w_i_d_g_e_t _t_o_p _p_o_s_i_t_i_o_n
  229.           sets the source of the current text widget to be the same as
  230.            _w_i_d_g_e_t and specifies where the top display and where the insertion
  231.           cursor are.
  232.  
  233.  
  234.      sssseeeettttSSSSttttrrrriiiinnnngggg  _v_a_l_u_e
  235.           sets the text value.
  236.  
  237.  
  238.      sssseeeettttTTTTooooppppCCCChhhhaaaarrrraaaacccctttteeeerrrr  _t_o_p
  239.           sets the top position of the text display.
  240.  
  241.  
  242.      sssshhhhoooowwwwPPPPoooossssiiiittttiiiioooonnnn  _p_o_s_i_t_i_o_n
  243.           force the text at the  _p_o_s_i_t_i_o_n to be displayed.
  244.  
  245.  
  246. CCCCAAAALLLLLLLLBBBBAAAACCCCKKKK SSSSUUUUBBBBSSSSTTTTIIIITTTTUUUUTTTTIIIIOOOONNNNSSSS
  247.      The substitutions supported for this class are
  248.           %%%%rrrreeeeaaaassssoooonnnn  - the additional values are
  249.                activate
  250.                focus
  251.                gain_primary
  252.                lose_primary
  253.                modifying_text_value
  254.                moving_insert_cursor
  255.                value_changed
  256.           %%%%ddddooooiiiitttt - the tcl variable to set to true or false to allow changes
  257.           %%%%ccccuuuurrrrrrrrIIIInnnnsssseeeerrrrtttt - current position of the insertion cursor
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. TTTTmmmmTTTTCCCCSSSSeeeexxxxtttt((((3333TTTTmmmm))))                                                    TTTTmmmmTTTTCCCCSSSSeeeexxxxtttt((((3333TTTTmmmm))))
  269.  
  270.  
  271.  
  272.           %%%%nnnneeeewwwwIIIInnnnsssseeeerrrrtttt - position to which cursor move is attempted
  273.           %%%%ssssttttaaaarrrrttttPPPPoooossss - itcl variable with starting position of text to modify
  274.           %%%%eeeennnnddddPPPPoooossss - tcl variable with end position of text to modify
  275.           %%%%ppppttttrrrr - tcl variable with text to be inserted
  276.           %%%%lllleeeennnnggggtttthhhh - tcl variable with length of text to be inserted
  277.  
  278.  
  279. AAAAUUUUTTTTHHHHOOOORRRR
  280.      Jan Newmarch, University of Canberra
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.